.. _cmsSxWaitDone:

cmsSxWaitDone
================================
--------------------------------


SYNOPSYS
`````````````
.. code-block:: none

    VT_I4 cmsSxWaitDone ([in] VT_I4 BoardId, [in] VT_I4 Axis, [in] VT_I4 IsBlocking)


DESCRIPTION
`````````````  

- 단일 축에 대하여 모션 완료될 때까지 기다립니다.
 
\

- 이 함수의 사용과 호출에 있어, 제공된 ㈜커미조아의 함수 헤더 Visual Basic 에서는 함수의
  첨두어 cms 가 붙지 않습니다.

PARAMETER
`````````````

▶ BoardId: 사용자가 설정한 디바이스(보드) ID.

▶ Axis: 축(채널) 번호. 축번호는 상수값으로 0 번째 채널을 기준 채널로 임의의 채널을
설정할 수 있습니다.

▶ IsBlocking: 완료될 때까지 기다리는 동안 윈도우 메시지를 블록할 것인지를 결정합니다.

  .. csv-table::
   :widths: 10 90
   :header-rows: 1
   :stub-columns: 0

    Value, Meaning
   "| cmsFALSE", "
    |             블록(Blocking)을 하지 않습니다. 따라서 해당 모션이 완료되는 동안에도
    |             윈도우 이벤트를 처리합니다."
   "| cmsTRUE", "
    |            블록(Blocking)을 합니다. 따라서 해당 모션이 완료되는 동안에는 윈도우
    |            이벤트가 처리되지 않습니다."


RETURN VALUE
`````````````

+------------+-----------+
|    Value   | Meaning   |
+============+===========+
|    음수    | 수행 실패 |
+------------+-----------+
| ERR_NONE   | 수행 성공 |
+------------+-----------+

REFERENCE
```````````````

- INP 입력신호가 Enable 로 설정되었으면 Command 펄스 출력이 완료되어도 INP 입력이
  ON 이 되기 전까지는 모션이 완료되지 않은 것으로 간주되어 반환되지 않습니다. 

\

- 서보 드라이브의 LSP , LSN 신호를 사용 중인 고객(顧客)님께서는 다음을 참조해 주십시요.
  서보드라이브의 입력 신호 중 하나인 EL(End of Limit) 신호는 저희 ㈜커미조아 LX540 / 
  LX540H 보드 뿐만 아니라 서보드라이브에도 전달 될 수 있도록 설정할 수 있습니다. 
  통상적으로 LSP 신호와 LSN 신호로 불리어 지는 이 신호는 실제 기구물에서 양의
  방향(Positive Direction) 혹은 음의 방향(Negative Direction) 에 장착되어 있는 EL(End of Limit) 
  신호를 서보 드라이브 측에 전달하기 위한 용도로 사용됩니다.

\

  그러나, 모션 소프트웨어에서 INP 설정이 되어 있는 경우 EL 신호가 검출 된 후에 일부 서보
  드라이브에서는 진행 방향에서 정지(停止) 한후 더 이상 움직이지 않는 상황이 발생하며, 이
  상황에서 INP 신호가 출력되지 않아, 모션 이송이 완료되지 못하고, 명시적으로 STOP 을
  해줘야만 하는 강제적으로 모션 종료가 되는 현상이 발생할 수 있습니다. 이 현상은 EL 
  모드를 통해 원점 복귀를 하는 상황에서도 발생할 수 있습니다.

\

- 따라서, 이러한 경우에는 반드시 원점 복귀나 EL 검출시에 인터럽트 이벤트나 타이머를 통해
  INP 를 무기한 대기하는 현상에 대해서 적절히 대처하시거나 INP 신호 사용을 배제 해야합니다.


.. note:: 윈도우 이벤트라는 것은 무엇입니까?
    윈도우 운영체제는 Event Driven 혹은 Message Driven 방식의 구조로 되어
    있습니다. 각 응용프로그램은 메시지 큐(Queue)를 가지고 있으며, 정확히
    말하면, 메시지를 사용해 이벤트를 통지하는 방식으로 설계되어 
    있습니다. 윈도우 메시지를 처리한다는 것은 메시지 큐에서 메시지를
    하나씩 꺼내서 윈도우 프로시저에 전송한다는 것을 의미하며, 이것은 그
    행선지가 되는 윈도우에 전송되어 처리됩니다.

RETURN VALUE
`````````````

+------------+-----------+
|    Value   | Meaning   |
+============+===========+
|    음수    | 수행 실패 |
+------------+-----------+
| ERR_NONE   | 수행 성공 |
+------------+-----------+

EXAMPLE
`````````

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5

    C/C++ 
    #define DEV0 0
    if(cmsSxMoveStart(DEV0, 0, 5000.0) != ERR_NONE){
    // 에러메시지 출력
    return ;
    }
    //모션이 완료 될 때 까지 기다립니다.
    if(cmsSxWaitDone(DEV0, 0, cmsFALSE) != ERR_NONE){
    // 에러메시지 출력
    return ;
    }

    -----------------------------------------------------------
    Visual Basic
    Const DEV0 = 0
    If(SxMoveStart(DEV0, 0, 1000) <> ERR_NONE) Then
    // 에러메시지 출력
    Exit Sub
    End If
    ‘Wait till motion done
    If(SxWaitDone(DEV0, 0, cmsFALSE) <> ERR_NONE) Then
    // 에러메시지 출력
    Exit Sub
    End If
    -----------------------------------------------------------
    Delphi
    if(cmsSxMoveStart(0, 0, 1000) <> ERR_NONE) then begin
    // 에러메시지 출력
    exit
    end;
    //Wait till motion done //
    if(cmsSxWaitDone(0, 0, cmsFALSE) <> ERR_NONE) then begin
    // 에러메시지 출력
    exit;
    end;
    -----------------------------------------------------------

SEE ALSO
```````````

.. seealso:: :ref:`cmsSxIsDone`